03 March 2025

REST Services Changes for 4.36

The following changes have been made to REST Services for 4.36:

The following REST Services have been added.

REST Service URL Verb
Update Consents <web services URL>/Consents/{personCode} PUT
Get ILP Comments <web services URL>/ILPComments/GetILPComments?type={linkType}&id={linkId} GET
Get ILP Learner Comment by Id <web services URL>/ILPComments/GetILPComment/{commentId} GET
Create ILP comment for a target <web services URL>/ILPComments/CreateILPTargetComment POST
Create ILP question comment for a learner <web services URL>/ILPComments/CreateILPQuestionComment POST
Update ILP comment for a learner <web services URL>/ILPComments/UpdateILPComment PUT
Delete ILP Comment <web services URL>/ILPComments/DeleteILPComment DELETE
Get ILP Targets <web services URL>/ILPLearnerTargets/GetILPTargets?type={targetTypes}&learner={learnerId} GET
Get ILP Learner Target by Id <web services URL>/ILPLearnerTargets/GetILPTarget/{targetId} GET
Create ILP target for a learner <web services URL>/ILPLearnerTargets/CreateILPTarget POST
Update ILP target for a learner <web services URL>/ILPLearnerTargets/UpdateILPTarget PUT
Delete ILP Target <web services URL>/ILPLearnerTargets/DeleteILPTarget/{targetId} DELETE
Change ILP Target Status <web services URL>/ILPLearnerTargets/UpdateILPTargetStatus PUT
Change ILP Target Step Status <web services URL>/ILPLearnerTargets/UpdateILPTargetStepStatus PUT

The following  fields have been added to the Employments section of the Update Person REST Service:

  • OtherEmploymentType1

  • OtherEmploymentType2

The following  fields have been added to the PeoplePriorAttainEntity section of the Create Person and Update Person REST Services:

  • PriorLevel

  • DateLevelApp

  • DateAchieved

  • IncludeInIlr

  • Confirmed

  • FesUser1

  • FesUser2

  • FesUser3

  • FesUser4

  • FesUser5

  • FesUser6

  • FesUser7

  • FesUser8

The following  fields have been added to the Create Fee Value and Update Fee Values REST services:

  • AllowRefund

  • IsTempVisaHolderFee

  • FeeCalculationMethod

  • TransactionType

  • FundingYear

  • IsStudyLink

  • RoundingMultiple

  • User1

  • User2

  • User3

  • User4

  • User5

  • User6

  • User7

  • User8

  • User9

  • User10

Service Pack 1 Changes

The following change has been made for 4.36 Service Pack 1:

The following REST Services have been added.

REST Service URL Verb
Create Unit Instance Hesa Deliv Organisations <web services URL>/UnitInstances/{uiCode}/UIHesaDelivOrganisations POST
​Update Unit Hesa Deliv Organisations <web services URL>/UnitInstances/{uiCode}/UIHesaDelivOrganisations PUT

The PeopleUnitsSpecialHesaFinances section has been added to Create Enrolment (POST), with the following fields:

  • Id

  • FundingYear

  • AppsSpend

  • FinAmount

  • FinType

  • FesUser1

  • FesUser2

  • FesUser3

  • FesUser4

  • FesUser5

  • FesUser6

  • FesUser7

  • FesUser8